Skip to content

Mac os readme fixes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
lukesmmr wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Mac os readme fixes #1

lukesmmr wants to merge 2 commits into from

Conversation

@lukesmmr
Copy link
Member

@lukesmmr lukesmmr commented Feb 7, 2026 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation

    • Added macOS (Apple Silicon / ARM) setup guide with platform-specific considerations, volume isolation details, and container initialization instructions

  • Chores

    • Updated Docker Compose configuration to ensure proper node_modules availability in the development environment

lukesmmr and others added 2 commits February 7, 2026 11:44
@lukesmmr @cursoragent
Fix Docker Compose for macOS and document setup learnings
dd782fc 
- Remove obsolete version key from docker-compose.yml to suppress deprecation warnings

- Add anonymous volume for node_modules to isolate Linux-native packages from macOS bind mount (prevents platform mismatch for esbuild, tsx, Prisma binaries)

- Document macOS Apple Silicon setup gotchas in README including PostGIS platform emulation, node_modules isolation, first-time setup commands, and Prisma OpenSSL warning

- Fix .gitignore: remove !dist/ and !build/ negations that accidentally un-ignored the dist/ directory, causing build artifacts like dist/proto/ to appear as untracked

Co-authored-by: Cursor <cursoragent@cursor.com>
@lukesmmr
chore(gitignore): reinstate previous changes
8ce6e61
@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Adds comprehensive macOS (Apple Silicon/ARM) documentation to README covering PostGIS platform considerations, node_modules volume isolation, container setup commands, and Prisma/OpenSSL notes. Configures docker-compose.yml to mount host node_modules into the api container for dependency isolation.

Changes

Cohort / File(s) Summary
macOS/ARM Setup & Dependency Configuration
README.md, docker-compose.yml		 README adds new section documenting Apple Silicon/ARM compatibility with platform considerations for PostGIS images, node_modules volume isolation strategy, first-time container setup commands, Prisma/OpenSSL notes, and clarification on running tests in container. docker-compose.yml adds volume mount for /usr/src/app/node_modules to persist host dependencies inside container.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A docker compose hop, with volumes so neat,
macOS ARM now has a welcome beat,
node_modules dance from host to the shell,
Documentation whispers—setup's done well!
Cross-platform magic, both fresh and refined! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Mac os readme fixes' is vague and generic, using non-descriptive phrasing that doesn't convey specific information about the changes despite the PR containing substantive modifications to both README and docker-compose.yml. Consider a more descriptive title such as 'Add macOS (Apple Silicon) setup documentation and node_modules volume mount' to clarify the specific changes made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mac-os-readme-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@lukesmmr lukesmmr requested a review from caspear February 8, 2026 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@caspear caspear Awaiting requested review from caspear

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@lukesmmr